Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

shelter: handle missing data in addressSuggestion (DEV-1168) #804

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tglaz
Copy link
Contributor

@tglaz tglaz commented Dec 23, 2024

[Shelter DB] In search box, some input break the whole page and becomes blank

https://betterangels.atlassian.net/browse/DEV-1168

Preview
https://shelter.dev.betterangels.la/address-bug

Summary by Sourcery

Bug Fixes:

  • Fix a bug where the shelter search page would break and become blank when some inputs resulted in missing address suggestion data.

Copy link

sourcery-ai bot commented Dec 23, 2024

Reviewer's Guide by Sourcery

This PR fixes a bug where the shelter search box would break and the page would become blank when some inputs were used. The fix handles cases where structured_formatting may be missing main_text or secondary_text fields by using default values. Additionally, the component now returns null if primaryText is missing, preventing the rendering of a broken component.

Sequence diagram for address suggestion handling with missing data

sequenceDiagram
    participant User
    participant AddressSuggestion
    participant GooglePlacesAPI

    User->>AddressSuggestion: Enter address text
    AddressSuggestion->>GooglePlacesAPI: Request address suggestions
    GooglePlacesAPI-->>AddressSuggestion: Return suggestion data
    Note over AddressSuggestion: Check for missing main_text
    Note over AddressSuggestion: Check for missing secondary_text
    alt main_text is missing
        AddressSuggestion-->>User: Return null (no suggestion shown)
    else main_text exists
        AddressSuggestion-->>User: Display formatted address suggestion
    end
Loading

State diagram for address suggestion component

stateDiagram-v2
    [*] --> CheckData
    CheckData --> NullState: missing main_text
    CheckData --> FormatAddress: has main_text
    FormatAddress --> DisplaySuggestion: format complete
    NullState --> [*]
    DisplaySuggestion --> [*]

    state FormatAddress {
        [*] --> CheckSecondaryText
        CheckSecondaryText --> UseMainText: has secondary_text
        CheckSecondaryText --> UseDescription: no secondary_text
        UseMainText --> [*]
        UseDescription --> [*]
    }
Loading

File-Level Changes

Change Details Files
Handle missing data in structured_formatting
  • Added default values for main_text and secondary_text fields of the structured_formatting object to prevent errors when these fields are missing.
  • Used the description field as a fallback for primaryText when secondaryText is missing and description is available.
  • Return null when primaryText is not available to prevent rendering a broken component on the page.
  • Removed trailing , USA from secondaryText for display purposes.
apps/shelter-web/src/app/shared/components/address/addressSuggestion.tsx

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @tglaz - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@tglaz tglaz self-assigned this Dec 23, 2024
@tglaz tglaz changed the title shelter: handle missing data in addressSuggestion shelter: handle missing data in addressSuggestion (DEV-1168) Dec 23, 2024
Copy link

@johnr54321 johnr54321 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tested on android and iphone. Can reproduce bug in other PRs, in this instance, the issue is gone. Pass.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants